/**
 * MIT License
 * 
 * Copyright (c) 2024 - present @ ebraid
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __EB_MUTEX_H__
#define __EB_MUTEX_H__

#include <types.h>

#ifdef __cplusplus
extern "C" {
#endif


typedef struct mutex {
    void *mutex_ptr;
} mutex_t;


/**
 * @brief initialize a mutex
 * @param mutex lock
 * @return none
 */
void mutex_init(struct mutex *mutex);


/**
 * @brief lock a mutex
 * @param mutex lock
 * @return none
 */
void mutex_lock(struct mutex *mutex);


/**
 * @brief unlock a mutex
 * @param mutex lock
 * @return none
 */
void mutex_unlock(struct mutex *mutex);


/**
 * @brief destroy a mutex
 * @param mutex lock
 * @return none
 */
void mutex_destroy(struct mutex *mutex);


#ifdef __cplusplus
}
#endif

#endif // __EB_MUTEX_H__